home *** CD-ROM | disk | FTP | other *** search
/ Aminet 16 / Aminet 16 (1996)(GTI - Schatztruhe)[!][Dec 1996].iso / Aminet / util / cdity / wc37_53.lha / WinCommodity / WinCommodity_eng.DOC < prev    next >
Text File  |  1996-10-13  |  19KB  |  541 lines
  1.  
  2.  
  3.                  WinCommodity 37.52
  4.  
  5.             WinCommodity ©1996 by «Michael Gollmick»
  6.  
  7. This documentation describes the program WinCommodity, the useful  utility  for
  8. the dayly work with your Amiga.
  9. WinCommodity requires at least version 2.04 of the AmigaOS.
  10.  
  11. - GENERAL -
  12.  « Introduction           »
  13.  « Installation and start »
  14.  « About the program      »
  15.  
  16. - BASICS -
  17.  « Usage                  »
  18.  « Preferences            »
  19.  
  20. - FUNCTIONS -
  21.  « Function overview      »
  22.  
  23. - APENDIX - 
  24.  « Known Bugs             »
  25.  « The future             »
  26.  « History                »
  27.  
  28.  
  29.  
  30. About the Program
  31.  
  32. Actual version: 37.52
  33.  
  34. This program is «MAILWARE» (see «Distribution»).
  35.  
  36. WinCommodity has prooven to be stable in everyday use
  37. WinCommodity was written in AmigaE and compiled using AmigaE v3.2e.
  38.  
  39.  
  40.  
  41. WinCommodity provides 7 functions this time:
  42.  
  43.  «CenterWins » - centring the active Window
  44.  «ParentWin  » - move window below its previous one
  45.  «ZipWin     » - minimize/maximize the active window
  46.  «CloseWin   » - close the active window
  47.  «CloseWBWins» - close all workbenchwindows
  48.  «ToggleWins » - activates the next window
  49.  «TopLeft    » - move window to left upper corner of screen
  50.  
  51. This functions may be installed, but do not need to be installed at all.
  52.  
  53.  
  54. Preferences
  55.  
  56. The preference-settings  are  really  simple.  Mark  the  WinCommodity-Icon  by
  57. clicking on it once with your mouse. Call the menuitem 'Pictogram/Information'.
  58. Now you can edit  the  Icon-Tooltypes.  The  included  Icon  has  all  possible
  59. Tooltypes  entered, you need only to change them for your wishes, if necessary.
  60. So, if you want to change a Hotkey, it  need  to  be  named  it  the  following
  61. format:
  62. <CX_FUNCTIONNAME=rawkey> + your keycombination
  63. Here you have TO enter standard workbench-key-names! (i.e. 'lalt' FOR the  left
  64. Alt  key,  'lcommand' FOR the left Amiga key). IF you have SET all preferences,
  65. click on the Gadget 'Save' AND the changes will take effect at  next  start  of
  66. WinCommodity.
  67.  
  68. The installed key-combinations may be  shown  while  WinCommodity  is  running.
  69. Herefore you have to call the GUI of WinCommodity. Since there is no Hotkey for
  70. the GUI you have to do this via the Commodity-Control-Program  'Exchange'.  (In
  71. my  opinion  there  is no sense in making a hotkey for a gui, I may need once a
  72. month, if I would need as often...)
  73. IF this GUI  is  called,  a  requester  appears,  which  shows  all  disposable
  74. functions  AND  its  hotkeys. IF a hotkey has not been accepted by the program,
  75. the function is not disposable AND the requester says 'NOT INSTALLED' FOR  this
  76. feature.
  77.  
  78.  Example-Configuration:
  79.  «CX_CENTERKEY     » -- F1
  80.  «CX_CLOSEACTIVEWIN» -- Control w
  81.  «CX_CLOSEWBWINS   » -- Control LAmiga w
  82.  «CX_PARENTKEY     » -- F2
  83.  «CX_PRIORITY      » -- 0
  84.  «CX_TOGGLEKEY     » -- LAlt Tabulator
  85.  «CX_ZIPKEY        » -- F3
  86.  «CX_TOPLEFTKEY    » -- Control F2
  87.  
  88.  
  89. TopLeft
  90.  
  91. This function moves the active window to the left top border of its screen. But
  92. WinCommodity  does  not  choose  the  physical  0,0-position  of the screen, it
  93. chooses the position directly below the ScreenBar.
  94.  
  95.  
  96. ToggleWins
  97.  
  98. This function toggles between the  windows.  If  called,  the  next  window  in
  99. screens  window-structure  will  be  activated an popped to front. WinCommodity
  100. cares about borderless or backdrop-windows and does not activate them.
  101. (This funtion has been adapted from X-Windows)
  102.  
  103.  
  104. CloseWBWins
  105.  
  106. This function is nearly similar to «CloseWins», except that  WinCommodity  does
  107. only  close  Workbench-Windows  and  does  close  all it can find (not only the
  108. active one). Workbench's main window will not be closed.
  109. The Idea of this function is old, it has been adapted from the MacOS  not  only
  110. once.  But  I  newer before saw such a unction, which does not try TO close the
  111. Workbench-main-window.
  112. --> Here it is necessary TO do a remark. This function  is  fast!  But  it  may
  113. become  timeful  if  you  do  open  too  much windows, since it first scans all
  114. windows and then it starts closing the  Workbenchwindows,  beginning  with  the
  115. most  back  one.  Herefore  it  has  to  allocate  memory  for each window (for
  116. programmers: this is a recursive function). Do, if you have  too  many  windows
  117. open,  layers.library  starts  to  become  slow, because of the lot windows and
  118. WinCommodity has to wait for each window to be closed. This can take a  lot  of
  119. time.  Example:  On my machine, an A1200 with 28MHz 68020 processor and 10MB it
  120. took around 6 mins to close 60 Workbenchwindows! (But how  often  do  you  open
  121. more than 60 Workbenchwindows???)
  122.  
  123.  
  124. CloseWin
  125.  
  126. This function does the same as a click on the CloseGadget of a window.
  127.  
  128. 1) In PageStream3, there is a non-standard system of Inuition-Message-handling.
  129. Therefore PageStream3-View-Windows will not be closed - they will be minimized!
  130. ...Not my fault.
  131.  
  132.  
  133. CenterWins
  134.  
  135. This function centers the active window on its screen. The screenbar is ignored
  136. in the calculation.
  137.  
  138.  
  139. ParentWin
  140.  
  141. This function moves  the  avtive  window  below  the  window-topborder  of  its
  142. parentwindow.  This  function  is  really  useful,  if  you  want  to have some
  143. arrangemant in your directory-structure.
  144. IF there is no parentwindow, the window will be  placed  below  the  screenbar,
  145. just like with «TopLeft».
  146.  
  147.  
  148. ZipWin
  149.  
  150. This function does the same as a click on  the  Zip-Gadget  of  a  window:  The
  151. window will be sized to minimum/maximum size
  152.  
  153.  
  154. -CX_CENTERKEY:
  155.  
  156. Here you enter the keycombination FOR the windowcentering.
  157. IF you want TO change the presetted value, you  have  TO  enter  the  followin:
  158. rawkey,  followed  by  the  keys,  you  want  tho activate this function. (i.e.
  159. 'rawkey ctrl esc' FOR Ctrl + ESC keys)
  160.  
  161.  
  162. General information
  163.  
  164.  «Copyright   » WinCommodity is MAILWARE!
  165.  «Disclaimer  » Warranty
  166.  «Requirements» an Amiga :-)
  167.  «Arisement   » Wie kam's dazu?
  168.  «Thanks      »
  169.  
  170.  
  171. Arisement
  172.  
  173. As other users, I was a bit angry for a long time about some misse dfeatures in
  174. the AmigaOS, I knew from other platforms.
  175. One day I got a small program, promising a bit help. It brought me one  of  the
  176. missed  functions  AND  this  one  was not really good codet, so I got Problems
  177. using this program.
  178. Therefore I decided TO give my very best in coding this FOR  my  own  AND  also
  179. implement all the other features. Some problems at start were solved AND so the
  180. program growed. There was only one more Problem: The documentation. But one day
  181. I  had  a readable Doc (in german) putted it together AND publicated it. THEN I
  182. continued developing AND this is exactly what you can see now!
  183. So I wish you the very best with my program AND I hope  I  fill  the  gap,  the
  184. AmigaOS had FOR me, also FOR you.
  185.  
  186.  
  187. Distribution
  188.  
  189. ------8<-------------------------------------------------------------------
  190. This software is subject to the "Standard Amiga FD-Software Copyright Note"
  191. It is <type_of_software> as defined in paragraph 4b. If you like it and use
  192. it regularly, please send an E-mail or postcard to «me».
  193. For more information please read «AFD-COPYRIGHT» (Version 1 or higher).
  194. ------8<-------------------------------------------------------------------
  195.  
  196. With other words: This program is freely distributable and should be copied  to
  197. nearly almost everyone you know!
  198. If this program is included into any PD-collection  i  strongly  please  for  a
  199. short  notification/request,  since  there  is  possibly  a more actual version
  200. finished and I also want to  be  on  the  run  about  the  publications  of  my
  201. software.
  202.  
  203. «Disclaimer»
  204.  
  205.  
  206. Requirements
  207.  
  208. You only require Kickstart 2.04 or higher for running WinCommodity
  209.  
  210. The following System-Libraries will be also required:
  211.        icon.library        v36
  212.        intuition.library   v37
  213.        commodities.library v37
  214.        intuition.library   v37
  215.        dos.library         v37
  216.  
  217. This librarires are already inside your Amiga, so don't panic if you can't find
  218. them in LIBS: (they are in the Kickstart-ROM).
  219.  
  220.  
  221. Usage
  222.  
  223. WinCommodity is a Commodity. It may be put into  the  directory  SYS:WBStartup,
  224. and will then be loaded after each reset.
  225. WinCommodity  provides  its   functions   via   Hotkeys.   This   Hotkeys   are
  226. «configurable». It is useful TO choose this Hotkeys in a easy TO reach AND also
  227. logical way.  The  included  Icon  has  a  demo-configuration,  which  has  the
  228. following presets:
  229.  
  230.  «CX_CENTERKEY     » -- F1
  231.  «CX_CLOSEACTIVEWIN» -- Control w
  232.  «CX_CLOSEWBWINS   » -- Control LAmiga w
  233.  «CX_PARENTKEY     » -- F2
  234.  «CX_PRIORITY      » -- 0
  235.  «CX_TOGGLEKEY     » -- LAlt Tabulator
  236.  «CX_ZIPKEY        » -- F3
  237.  «CX_TOPLEFTKEY    » -- Control F2
  238.  
  239. As a Commodity, WinCommodity is accesable via the 'Exchange'-Utility. Here  you
  240. also  can  activate  the  GUI  of  WinCommodity.  With  'Exchange' you can quit
  241. WinCommodity, if this would ever be  necessary.  WinCommodity  also  quits  for
  242. itself if you start it twice. (without any notice!)
  243. Calling the functions is really easy after  starting  WinCommodity:  Press  the
  244. Hotkey-combination of your choice AND its function will be called.
  245. Example: FOR centering the  active  window,  press  'F1'.  The  window  will 
  246. be centered right now. Now there should be no more problem using WinCommodity
  247.  
  248.  
  249. -CX_PRIORITY:
  250. The priority, the Commodity will get in the AmigaOS. It is presetted TO '0'. IF
  251. you can't HANDLE the term 'priority', be aware of this value!
  252.  
  253.  
  254.  
  255. -CX_CENTERKEY:
  256. Here you enter the Hotkey FOR window centering.
  257. If you want to change the presetted value, you  have  to  enter  the  followin:
  258. rawkey,  followed  by  the  keys,  you  want  tho activate this function. (i.e.
  259. 'rawkey ctrl esc' for Ctrl + ESC keys)
  260.  
  261.  
  262. -CX_PARENTKEY:
  263.  
  264. Here you enter the Hotkey FOR  the  windowmoving  below  its  parenwindow.  The
  265. parentwindow  is  the  window which is directly parent TO the active one, so it
  266. need'nt TO be the physical parent one
  267. IF you want TO change the presetted value, you  have  TO  enter  the  followin:
  268. rawkey,  followed  by  the  keys,  you  want  tho activate this function. (i.e.
  269. 'rawkey ctrl esc' FOR Ctrl + ESC keys)
  270.  
  271.  
  272. -CX_ZIPKEY:
  273.  
  274. Here you enter the Hotkey FOR Ziping the window.
  275. If you want to change the presetted value, you  have  to  enter  the  followin:
  276. rawkey,  followed  by  the  keys,  you  want  tho activate this function. (i.e.
  277. 'rawkey ctrl esc' for Ctrl + ESC keys)
  278.  
  279.  
  280. -CX_TOGGLEKEY:
  281.  
  282. Here you enter the Hotkey FOR toggling between the windows.
  283. If you want to change the presetted value, you  have  to  enter  the  followin:
  284. rawkey,  followed  by  the  keys,  you  want  tho activate this function. (i.e.
  285. 'rawkey ctrl esc' for Ctrl + ESC keys)
  286.  
  287.  
  288. -CX_CLOSEWBWINS
  289.  
  290. Here you enter the Hotkey FOR closing all Workbench-windows.
  291. If you want to change the presetted value, you  have  to  enter  the  followin:
  292. rawkey,  followed  by  the  keys,  you  want  tho activate this function. (i.e.
  293. 'rawkey ctrl esc' for Ctrl + ESC keys)
  294.  
  295.  
  296. -CX_CLOSEACTIVEWIN
  297.  
  298. Here you enter the Hotkey FOR closing the active window.
  299. If you want to change the presetted value, you  have  to  enter  the  followin:
  300. rawkey,  followed  by  the  keys,  you  want  tho activate this function. (i.e.
  301. 'rawkey ctrl esc' for Ctrl + ESC keys)
  302.  
  303.  
  304. -CX_TOPLEFT
  305.  
  306. Here you enter the Hotkey FOR moving the window on the left  border  below  the
  307. screenbar.
  308. If you want to change the presetted value, you  have  to  enter  the  followin:
  309. rawkey,  followed  by  the  keys,  you  want  tho activate this function. (i.e.
  310. 'rawkey ctrl esc' for Ctrl + ESC keys)
  311.  
  312.  
  313. Installation
  314.  
  315. Simply use the Installer-Script, I hardly tried to create one which is  perfect
  316. for the first installation as also for updates.
  317. (You will need the 'Commodore Installer' FOR this script)
  318. If you really don't want to use this Script, you should put the Program to  the
  319. directory  you  want to have it to and put the file 'WinCommodity_eng.Guide' to
  320. your documentation-directory (usually this is 'HELP:')
  321.  
  322. There are some files in the directory which will not  be  copied,  but  may  be
  323. interesting for you:
  324.  - 'CHANGES'   a german textfile withe the last changes in the program
  325.  - '.HISTORY'  the full history of WinCommodity (in english)
  326.  
  327.  
  328. If you are a programmer, the 'dev/' directory may be interesting for you. There
  329. are  includes for AmigaE in 68000, 68020 and 68040-version and also autodocs in
  330. AmigaGuide© format.
  331.  
  332.  
  333. Bugs
  334.  
  335. At the moment I don't know any Bug.
  336.  
  337. WinCommodity does really work fine on my machine. IF you do get problems  using
  338. WinCommodity OR IF you have any idea FOR it OR IF you want TO do a translation,
  339. contact «me». The fastest way is as ever an e-mail, but a letter will  also  do
  340. it.
  341. IF you want TO get the latest version WinCommodity, put the the amount of 5,-DM
  342. (german  marks) in your currency into the letter AND it TO me with some lines I
  343. will send you a disk with the latest version of WinCommodity AND other software
  344. of mine. (This money is only FOR saving my own costs)
  345.  
  346.  
  347. The future
  348.  
  349. The future of WinCommodity belongs to you. If I will get  enough  feedback  and
  350. some new ideas, I will continue developing. If there are any bugreports, I will
  351. fix that bugs and make a new version.
  352. WinCommodity is MAILWARE AND will stay MAILWARE. It will not  become  Shareware
  353. at any time!
  354. If you have any idea for WinCommodity, send it to «me»!
  355.  
  356.  
  357. Credits
  358.  
  359. Many thanks to:
  360.         Rene Kotte
  361.          - who hardly worked on getting an include for me, which was
  362.            lost on my system
  363.  
  364.         kelly.uni-paderborn.de
  365.          - the ftp-server, which had this include
  366.  
  367.         Pascal Behrend
  368.          - which gave me a really good tip for closing a window via
  369.            Intution.library-notification
  370.  
  371.         Commodore
  372.          - for the best computer in the world
  373.  
  374.         EsCOM
  375.          - which got bancrupty for my dearest Computer :-))
  376.  
  377.         VisCorp
  378.          - which could get the bancrupty-rests in the last moment and
  379.            hopefully will do a bit more with it as EsCOM
  380.  
  381.         Wouter van Oortmerssen
  382.          - for his genious AmigaE
  383.  
  384.  
  385.  
  386. History
  387.  
  388. The historical notes are listed here in the sort of  its  publication.  A  full
  389. history is available in the archive in '.HISTORY'.
  390.  
  391. 22 Sep 1996 : 037.052 :  functions will now only be installed IF they are
  392.              named in the icon, else they are shown as
  393.              'NOT INSTALLED' in Config-Window
  394.              about() is overworked now - shows config
  395.              internal optimization and a new feature addet:
  396.              lefttop() - window will be moved to the left top
  397.              corner, 040 version is now compiled as a true
  398.              040 version (has been a mix from 020 and 040
  399.              version before
  400. 06 Sep 1996 : 037.045 :  about() addet, broker is is now mounted as one
  401.              with GUI,
  402.              code optimized, ERROR now BEEPS the screen,
  403.              better Kickstart-Checking,
  404.              Installer-Script addet, now 020 an 040 Versions
  405. 02 Sep 1996 : 037.040 :  ToggleWins() does not activate BackdropWindows
  406.              anymore. Borderless- Nonmovable and Backdrop-
  407.              windows will not be centered nor moved anymore
  408. 01 Sep 1996 : 037.035 :  WBenchMainWin will not be closed anymore
  409. 21 Aug 1996 : 037.025 :  initial release
  410.  
  411.  
  412.  
  413.  
  414. Adresse:  Michael Gollmick
  415.       Lepsiusstraße 6
  416.       06618 Naumburg/Saale
  417.       Germany
  418.  
  419. e-Mail:   wir94dgk@zaix340.rz.uni-leipzig.de
  420.  
  421. IRC       nickname: qualle
  422.       channels: #leipzig, #amigager
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430. ..not available at the moment - sorry!
  431.  
  432. to contact me use my «address».
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.         __ __  *====================================*             __ __
  442.        / // /  *     Standard Amiga FD-Software     *            / // /
  443.       / // /   *         Copyright Note (TM)        *           / // /
  444.      / // /    *====================================*          / // /
  445.  __ __  / // /     *                                    *  __ __  / // /
  446.  \ \\ \/ // /      *       Version 1.1 - English        *  \ \\ \/ // /
  447.   \ \\/ // /       *            27-Feb-1995             *   \ \\/ // /
  448.    \ / // /        *                                    *    \ / // /
  449.     """ ""         *====================================*     """ ""
  450.  
  451. 0. INTRODUCTION
  452. ===============
  453.  
  454. If you are a user I hope you like this Standard Copyright Note for Free Dis-
  455. tributable Amiga Software you only have to read once  instead of individual
  456. notes.  There are translated versions  of this document available on Aminet
  457. named:
  458. /pub/aminet/docs/misc/AFD-Files1-xx.lha (xx = number of languages).
  459.  
  460. If you are a software developer  and want to include  this document in your
  461. own FD package then please  read it carefully first,  especially chapter 5
  462. "DEVELOPERS INFORMATION". Thank you for your support.
  463.  
  464.  
  465. 1. COPYRIGHT
  466. ============
  467.  
  468. a. This software is copyrighted by its developer(s). That means that you
  469.    are NOT ALLOWED to modify the program(s) and documentation in any way.
  470.    Especially you MUST NOT REMOVE the documentation or this text file.
  471.  
  472. b. You are NOT allowed to use this software or any part of it for any other
  473.    purpose than that one mentioned in its documentation, this also includes
  474.    any fonts,  images or samples.  If the developer(s)  did NOT include the
  475.    source code of the program(s) in this package you are NOT allowed to de-
  476.    compile any part of it.
  477.  
  478.  
  479. 2. DISTRIBUTION
  480. ===============
  481.  
  482. This package is freely distributable.  That means  you are allowed to re-
  483. distribute this package as long as you follow these points:
  484.  
  485. a. Any re-distribution  has to include  all files in this archive, including
  486.    this "AFD-COPYRIGHT" file, without any modifications. You are NOT allowed
  487.    to add any files to the archive.
  488.  
  489. b. This package may be freely distributed via BBSs, InterNet/UseNet,
  490.    software libraries such as Fred Fish's and Aminet CD-ROM, and other
  491.    similar electronic channels.
  492.  
  493. c. Disk magazines and services that charge extra for file transfers may
  494.    NOT distribute it without written permission by the developer(s)!
  495.  
  496.  
  497. 3. DISCLAIMER
  498. =============
  499.  
  500. By using this product, you accept the FULL responsibility for any damage
  501. or loss that might occur through its use or the inability to use it. The
  502. developer(s) of the software  and the author and the translators of this
  503. "Copyright Note" can NOT be held responsible.
  504.  
  505. IMPORTANT: The author and the translators of this "Copyright Note" do
  506.        NOT give any  guarantee for the quality and usefulness of
  507.        ANY products that are subject to this note!!!
  508.  
  509.  
  510. 4. RETURN SERVICE
  511. =================
  512.  
  513. "Free distributable" only says that you do not have to pay for copying or re-
  514. distributing the software. You are allowed to test this product for 30 days.
  515. If you like it and decide to use the product regularly,  most of the develo-
  516. pers want something in return for their efforts.
  517.  
  518. The documentation of this software contains one classification out of these:
  519.  
  520. a. Freeware - You are allowed to use this software FREE.
  521.  
  522. b. Mailware - You have to send the developer(s) a MESSAGE
  523.           (by email or snailmail).
  524.  
  525. c. Cardware - You have to send the developer(s) a POSTCARD.
  526.  
  527. d. Donationware - You have to make a DONATION to an organisation as stated
  528.           in the documentation to this product.
  529.  
  530. g. Giftware - You are requested to send the developer(s) a GIFT,
  531.           for example:
  532.                  - some candy or
  533.                  - a package of disks or
  534.                  - a copy of a self-made program or
  535.                  - some money or
  536.                  - an Amiga 5000 PowerTower ;-)
  537.  
  538. s. Shareware - You have to send the developer(s) the amount of MONEY
  539.            demanded in the documentation.
  540.  
  541.